home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1996 April: Mac OS SDK / Dev.CD Apr 96 SDK / Dev.CD Apr 96 SDK1.toast / Development Kits (Disc 1) / OpenDoc / Debugging OpenDoc / Tools / DumpDraft / README - DumpDraft next >
Encoding:
Text File  |  1995-11-08  |  3.5 KB  |  62 lines  |  [TEXT/ttxt]
  1. DumpDraft
  2.  
  3. DumpDraft is an application which is used to dump all the objects in the top draft in an OpenDoc™ Document created by the Bento Container Suite.
  4.  
  5. •    Changes since DR3:
  6. - "DumpDraft Storage" and "DumpDraft Bento" are no longer needed.
  7. - A watch cursor is added and is spinning during the dump operation.
  8. - A dialog box is used to show the object being processed. (This is actually quite useless, but is a good indication that things are working.)
  9. - Command-period will stop the dump operation.
  10. - DumpDraft creates a file with a unique name for the dump.
  11. •    Changes since DR2:
  12. The associated libraries are renamed to DumpDraft Storage and DumpDraft Bento to distinguish them from the OpenDoc libraries.
  13. • Changes since DR1:
  14. - DumpDraft for 68K is not supported for DR2.
  15. - New CFM Libraries are required for using DumpDraft.
  16.  
  17. • Installation:
  18.  
  19. Just drag the DumpDraft application to your local hard disk.
  20.  
  21. • Usage:
  22.  
  23. To use DumpDraft application, drop the OpenDoc Document onto DumpDraft. A file will be created in the same folder as your OpenDoc Document. The name of the dump file will be the name of the original OpenDoc Document with "dump #" as a suffix where # is a unique number.
  24.  
  25. DumpDraft is VERY IO-intensive. That means your drive may act differently than usual. For example, we've seen the disk head moves continuously during the dump as if the drive is being reformatted. Don't panic as this is normal behavior. The dump will finish (depending on the size of your document, the number of objects in the document, the speed of your drive and how fragmented your drive is.)
  26.  
  27. If you want to stop the dump operation, you can try command-period. The dump should stop momentarily.
  28.  
  29. • Format:
  30.  
  31. The following is an example of what a dumped object may look like:
  32.  
  33. === Object 3 === 
  34.  
  35. Property: OpenDoc:Metadata:StorageUnitType
  36. OpenDoc:Type:ISOStr Length: 64
  37. +//ISO 9070/ANSI::113722::US::CI LABS::OpenDoc:ObjectType:Frame
  38.  
  39. Property: OpenDoc:Metadata:Part
  40. OpenDoc:Type:StorageUnitRef Length: 4
  41.  2 00 00 00 
  42. Strong SURef 2000000 --> Object 2
  43.  
  44. Line 1 shows the id of the object. This id is only used to identify the object in this dump and is meaningless in the programmatic context.
  45. Line 3-5 show the first Property which contains the Storage Unit Type. Line 3 shows the property name. Line 4 shows the value type and the length of the value. Line 5 shows the content of the value.
  46. Line 7-10 show the second property. Line 7 shows the property name. Line 8 shows the value type and the length of the value while line 9 shows the content of the value. Line 10 shows the object to which the storage unit reference is referring. 
  47.  
  48. Note that the ISO prefix for OpenDoc is not shown for the property names and value types.
  49.  
  50. • Limitations:
  51.  
  52. 1) As one can see from the previous example, not all types are displayed in a user-meaningful way. Whenever an unknown type is encountered by this tool, a hex dump of the Value is used instead.
  53. 2) This application is strictly read-only. Therefore, one cannot alter the OpenDoc Document using this tool.
  54. 3) This application only works with OpenDoc Document created by the Bento Container Suite.
  55. 4) This application can only dump the top Draft of the document.
  56. 5) The Human Interface of this application is EXTREMELY poor. Please pardon its appearance while it is under construction.
  57. 6) This application only works on PPC.
  58.  
  59. • Disclaimers:
  60.  
  61. 1) Even though DumpDraft is non-destructive in nature, there is a very slight chance that DumpDraft would damage your OpenDoc Document. To be on the safe side, you should duplicate your file and use DumpDraft on the copy.
  62. 2) THIS IS AN UNSUPPORTED PRODUCT.